Upgrade Operator Connect Customer License

This request enables you to upgrade the customer license type from OC Essential to either OC EssentialPlus or OC OC Pro. Once you have successfully run this POST request, you must also run the PATCH request Upgrade or Downgrade Service License to validate the App Registration credentials for accessing the customer M365 platform.

URI

Copy

{{baseUrl}}/api/v2/customer/{customerGuid}/action/upgrade

HTTP Method

POST

Request Parameters

Parameter	Type	Description
CustomerGuid	string ($uuid)	umpCustomerGuid created in the Live Platformcustomer tenant SQL database: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead. This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

Parameter

Type

Description

CustomerGuid

string ($uuid)

umpCustomerGuid created in the Live Platformcustomer tenant SQL database: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

Request Body

Parameter

Mandatory

Type

Description

customerFullName

string

The full customer name of the OC Essential service.

UpgradetoLicense

integer

Indicates the Live Platform license type for which you wish to upgrade:

■

4: OC Essentials Plus

■

5: OC Pro

licenseCount

integer

The number of required licenses for the configured license type.

Example Request Body

Copy

{
  "UpgradetoLicense": 5,
  "licenseCount": 50
 }

Example Response

The initial response displays the Task Id.

Parameter	Type	Description
taskId	string	The queued task Id that is generated for this action. You must run the Task request to retrieve the status of the action. See Task Status. Note that the tsk_ string in the prefix is unique for this endpoint.

Copy

"tsk_185510"

The execution of the request may take a few minutes. The status will progress from 'In Progress' to 'Completed Success'. See for details.

Copy

{
    "id": "tsk_20828778",
    "status": "InProgress",
    "details": [
        null
    ],
    "executionMessages": [],
    "outputData": {}
}

Copy

{
    "id": "tsk_185510",
    "status": "CompletedSuccess",
    "details": [
        null
    ],
    "executionMessages": [],
    "outputData": {},
    "createTime": "0001-01-01T00:00:00",
    "completeTime": null,
    "cancellationRequested": null
}

HTTP Responses

■

200 OK

Parameter

Type

Description

string

The task Id that is generated for this action. See Task Status.

status

string

Aggregated status reflecting update status on both the Live Platform and Operator Connect:

■

Completed Success

■

Failed

details

dictionary

Additional details.

executionMessages

string

Internal debugging messages.

outputData

dictionary

Dictionary including the following:

■

createTime

■

completeTime

■

cancellationRequested

createTime

string($date-time)

Timestamp indicating the time that the license upgrade request was initiated.

completeTime

string($date-time)

Timestamp indicating the time that the license upgrade request processing completed.

cancellationRequested

boolean

Indicates whether the request processing was canceled by the client application. This parameter is not relevant for Live Platform.

■

400 wrong value used: When the 'upgradetoLicense' parameter is configured with an invalid value:

Copy

{
  "upgradeToLicense": 7,
  "licenseCount": 20
}

Copy

The following error is raised:

Copy

{
    "title": "Value cannot be null. (Parameter 's')",
    "status": 500,
    "detail": "ErrorTicket=03a95735-ae13-4c3b-9f92-9fe30ff91db1"
}

See 'upgradeToLicense' parameters shown above for valid types.

■

403 Forbidden:

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk"
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

404 Not Found: Example: When the {customerGuid} is not included as Request parameter, the following error is raised.

Copy

{
    "title": "Customer with id: d5253892-1c1e-4b23-89d7-29d86734c31b not found",
    "status": 404
}

■

409 Conflict: The following error is raised when the tenant service has already been upgraded.

Copy

{
    "title": "Tenant is already upgraded: OC EssentialPlus",
    "status": 409
}

■

500 Internal Server Error: When a non-existing value for the license type is entered; in this example "7" is not a valid license value.

Copy

{
  "upgradeToLicense": 7,
  "licenseCount": 20

The following error is raised.

Copy

{
    "title": "Value cannot be null. (Parameter 'element')",
    "status": 500,
    "detail": "ErrorTicket=24cc35f6-524d-472b-9b54-db0fd144d025"
}